Each measure needs to have a unique name, which defines
a section in the ini-file for that measure. The name needs to be put
inside []-characters. The name doesn't matter as long as you don't use it
anywhere else in the same ini-file. Do not use spaces in the names. The meters use the section names to bind to the
measures. Check the supplied ini-files for examples.
Important! Some meters require a range of values (BAR, HISTOGRAM, etc),
so that they can display the measured value as relative to the minimum and
maximum values. Not all measures are able to calculate the minimum and maximum
value automatically so you need to do that manually with MinValue and MaxValue.
General settings for all measures
Measure
This defines what is measured. The valid values are:
- CPU - Measures total load from all CPUs (Use
the PerfMon plugin if you want separate the CPUs).
- Memory - Measures overall memory utilization.
- PhysicalMemory - Measures allocated
physical memory.
- SwapMemory - Measures allocated swap.
- NetIn - Measures incoming network
traffic.
- NetOut - Measures outgoing network traffic.
- NetTotal - Measures outgoing network traffic.
- FreeDiskSpace - Measures free diskspace.
- PerfMon - Gets NT's performance data.
- Uptime - Shows how long your computer has been
on. This works only in a STRING-meter.
- Plugin - Measure is defined by an
external plugin.
- Registry - Measures registry values.
- Time - Measures time and date.
- Calc - Calculates formulas.
InvertMeasure
If set to 1, the measured value is inverted. E.g. you can
measure allocated disk space instead of free space.
IfAboveAction
A bang or command that is executed when the measure
goes above the value defined in IfAboveValue. The action
is executed only when the measure exceeds the value, so it needs to go
below the defined value before the action is executed again.
IfAboveValue
The value for IfAboveAction.
IfBelowAction
A bang or command that is executed when the measure
goes below the value defined in IfBelowValue.
The action is executed only when the measure falls below the value, so it needs to go above the defined value before the action is executed
again.
IfBelowValue
The value for IfBelowAction.
IfEqualAction
A bang or command that is executed when the measure
is equal with the value defined in IfEqualValue.
The action is executed only once when the measure is equal to the value, so it needs to go above
or below the defined value before the action is executed
again. The value is rounded to full integer.
IfEqualValue
The value for IfEqualAction.
Disabled
If set to 1, the measure is disabled at start.
UpdateDivider
This value determines how often the measures are updated. This is
bound to the Update value. For example if the Update is set to 1000 and
the UpdateDivider is 30, the measure is updated every 30 seconds. The
default value is 1.
MaxValue
The maximum value the measure can have.
MinValue
The minimum value the measure can have.
Substitute
A list of comma separated value pairs that can be used to change certain
value to another. You must use quotes around the values! E.g.
Substitute="cat":"dog" would change all cats to dogs in the measured value.
AverageSize
Defines the window size of average measuring. E.g. if this is set to 10
the returned value is average of last ten values.
NetIn
NetInSpeed
The maximum speed of your network connection input. The value is given
in bits per second. If this value is omitted or set to zero, the maximum
value is determined from the input. Watch out for peaks.
TrafficAction
Action to be executed when a certain amount of data has been downloaded.
TrafficValue
The value for the TrafficAction.
Interface
The index of the measured NIC. If this is set to 0 (default) all
interfaces are added together. Value 1 means the fisrt NIC, 2 the second,
etc.
Cumulative
If set to 1, the measure gathers cumulative value (i.e. adds the
measured values together). This can be used to measure the total amount of
transferred data during certain timeperiod.
NetOut
NetOutSpeed
The maximum speed of your network connection output. The value is given
in bits per second. If this value is omitted or set to zero, the maximum
value is determined from the input.
TrafficAction
Action to be executed when a certain amount of data has been uploaded.
TrafficValue
The value for the TrafficAction.
Interface
The index of the measured NIC. If this is set to 0 (default) all
interfaces are added together. Value 1 means the fisrt NIC, 2 the second,
etc.
Cumulative
If set to 1, the measure gathers cumulative value (i.e. adds the
measured values together). This can be used to measure the total amount of
transferred data during certain timeperiod.
NetTotal
NetTotalSpeed
The maximum speed of your total network connection. The value is given
in bits per second. If this value is omitted or set to zero, the maximum
value is determined from the input.
TrafficAction
Action to be executed when a certain amount of data has been uploaded and
downloaded.
TrafficValue
The value for the TrafficAction.
Interface
The index of the measured NIC. If this is set to 0 (default) all
interfaces are added together. Value 1 means the fisrt NIC, 2 the second,
etc.
Cumulative
If set to 1, the measure gathers cumulative value (i.e. adds the
measured values together). This can be used to measure the total amount of
transferred data during certain timeperiod.
FreeDiskSpace
Drive
This is the drive which diskspace is measured. E.g. "C:\"
Total
If set to 1 this returns the total size of the drive.
Label
If set to 1 this returns the label of the drive.
Plugin
Plugin
This defines the name of the plugin that handles the
actual measuring.
Registry
RegKey
The name of the registry key.
RegHKey
The name of the HKEY. Possible values are: HKEY_CURRENT_CONFIG,
HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT,
HKEY_PERFORMANCE_DATA and HKEY_DYN_DATA.
RegValue
The name of the registry keys value. Only string and
long values are supported.
Time
Format
The format how the time is written. E.g. "%H:%M:%S". You can find out
all the format codes from here:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_strftime.2c_.wcsftime.asp
You can also use "locale-time" and "locale-date" to use the format that is
used currently in the Windows.
TimeZone
The timezone value (e.g. +2.0). You can use also fractional values. If
this is not given the localtime is used.
DaylightSavingTime
If set to 1, the daylight saving time is applied to the time (it depends
on your local time). This is only used if the TimeZone has been set.
Calc
Formula
This defines the calculated formula. You can use other measures as
variables. There is also a special variable called Counter, which is
increased on every update. The variables are updated only after all
other measures are updated, so the values are one update cycle behind.
Note that everything is case sensitive and the functions must be in all
capital letters (e.g. SIN(10 * PI)).
Operations:
- + (add)
- - (substract)
- * (multiply)
- / (divide)
- ** (power)
- % (remainder)
- & (bitwise and)
- | (bitwise or)
- ^ (bitwise xor)
- ~ (bitwise not)
Logical operations:
- <> (not equal)
- = (equal)
- > (greater than)
- < (less than)
- && (logical and)
- || (logical or)
Functions:
ARCTAN, ARCSIN, ARCCOS, COS, SIN, TAN, ABS, EXP, LN, LOG, SQRT, SQR, SGN, SIGN, FRAC, TRUNC, FLOOR, CEIL, ROUND(x[, precision])
Conditional operator:
<condition> ? <true expr.> : <false expr.>